Skip to main content

SFTP Connector

SFTP Connector provides access to files and folders on an SFTP server. SFTP Connector operations manage file transfers over the SFTP (Secure File Transfer Protocol) protocol. The Connector’s main features include

The ability to read files or list directory contents on demand

Support for common SFTP operations such as creating directories, copying, moving, renaming, and deleting files

Support for locking files

File matching functionality

A design that is consistent with that of File Connector and FTP Connector

The same set of operations is available on these Connectors, and they behave similarly.

Drag and drop the SFTP Connector

SFTP Connector

Configuring SFTP Connector

left click on connector, you can define the SFTP Connector configration

Read SFTP Connector

Read SFTP Connector
FieldsDescriptionExample
TypeRead/WriteRead
Datasource NameDatasource Name which is configured in connections properties Please refer the link for instructions on creating the datasource namesftpcall
File NameName of the file to be processedContacts
File TypeFormat of FileCSV
OutPutOutputRest_output
OperationOperation of the fileMove
DestinationLocal destination file path/app/Schemas/Customers

Write SFTP Connector

Write FTP Connector
FieldsDescriptionExample
TypeRead/WriteWrite
Datasource NameDatasource Name which is configured in connections properties Please refer the link for instructions on creating the datasource namesftpcall
File NameProcessed FileContacts
File TypeFormat of FileCSV
InputInputREQUEST_PAYLOAD
Append/OverWriteSelect "append" to add the request or choose "overwrite" to modify the requestOverWrite

Retry

Retry is flag passed on connector nodes, like SFTP, to allow the step to be retryable if any exception occurs. It has 2 configurable properties.

  1. maxRetryAttempts: The max number of retries if any exception occurs. max attempts are 3.
  2. retryIntervalMillis: The max interval between retries. Max range is 6000ms.

Enable retry by cliking on the Enable Retry radio button at the top of the configuration pannel.

PAYLOAD transformer